/*
 * Licensed to Metamarkets Group Inc. (Metamarkets) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  Metamarkets licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.metamx.tranquility.samza

import com.metamx.tranquility.beam.Beam
import org.apache.samza.config.Config
import org.apache.samza.system.SystemStream

/**
 * Implement this class to link up Samza with Tranquility.
 */
trait BeamFactory
{
  /**
   * Create a Beam given a particular Samza SystemStream and Config. The Config is not subsetted; it's the config for
   * the entire job.
   *
   * @param stream stream for this beam
   * @param config config for this job
   * @return beam for a BeamProducer
   */
  def makeBeam(stream: SystemStream, config: Config): Beam[Any]
}
